/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.tree;

import java.util.Set;

import org.xwiki.component.annotation.Role;

/**
 * The interface used to filter tree nodes.
 * 
 * @version $Id$
 * @since 11.10
 */
@Role
public interface TreeFilter
{
    /**
     * Tree filters can implement both local and global exclusions. Local exclusions take into account the specified
     * parent node while global exclusions simply ignore it, returning a set of exclusions that apply to all nodes.
     * 
     * @param parentNodeId specifies the parent node to filter
     * @return the set of child nodes to exclude from the specified parent
     */
    Set<String> getChildExclusions(String parentNodeId);
}
